Skip to main content
PATCH
/
v1
/
organizations
/
{organization_id}
/
projects
/
{project_id}
/
compute
/
instances
/
{id}
[Instances] Partially update compute instance metadata
curl --request PATCH \
  --url https://api.onetsolutions.net/v1/organizations/{organization_id}/projects/{project_id}/compute/instances/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "hostname": "<string>",
  "size_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vpc_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "os_name": "<string>",
  "tags": "<unknown>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legacy_id": 123,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "size": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "vcpu": 2147483647,
    "ram_mb": 2147483647,
    "bandwidth_mbps": 2147483647,
    "available_volumes": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "disk_gb": 2147483647,
        "is_default": true,
        "is_active": true
      }
    ],
    "pricing_options": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "price": "<string>",
        "discount_percent": "<string>",
        "is_default": true,
        "is_active": true
      }
    ],
    "available_addons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "addon": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "name": "<string>",
          "name_fr": "<string>",
          "description": "<string>",
          "description_fr": "<string>",
          "is_active": true
        },
        "pricing_options": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "price": "<string>",
            "is_active": true
          }
        ],
        "is_included": true,
        "is_default": true,
        "is_active": true
      }
    ],
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true,
    "description": "<string>"
  },
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "country_code": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true
  },
  "vpc": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "cidr_block": "<string>",
    "location": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "country_code": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "is_active": true
    },
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "is_active": true
  },
  "image": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "os_name": "<string>",
    "os_version": "<string>",
    "language": "<string>",
    "is_windows": true,
    "requires_license_addon": true,
    "created": "2023-11-07T05:31:56Z",
    "modified": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "os_architecture": "<string>",
    "is_active": true,
    "is_featured": true,
    "min_disk_gb": 2147483647,
    "min_ram_mb": 2147483647
  },
  "os_name": "<string>",
  "primary_ipv4": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "primary_ipv6": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ip_addresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": "<string>",
      "interface": 123,
      "netmask": "<string>",
      "gateway": "<string>",
      "network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vlan": 123,
      "mac_address": "<string>",
      "is_primary": true,
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "reverse_dns": "<string>"
    }
  ],
  "volumes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "size_gb": 123,
      "disk_name": "<string>",
      "location": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "country_code": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "is_active": true
      },
      "price_monthly": "<string>",
      "is_active": true,
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "billing_start_date": "2023-11-07T05:31:56Z",
  "billing_end_date": "2023-11-07T05:31:56Z",
  "next_billing_date": "2023-11-07T05:31:56Z",
  "cancellation_requested_at": "2023-11-07T05:31:56Z",
  "cancellation_reason": "<string>",
  "bandwidth_used_gb": "<string>",
  "is_active": true,
  "is_installed": true,
  "state_sync": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_status": "<string>",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "uptime": 2147483647,
    "cpu_usage": "<string>",
    "memory_usage_mb": 2147483647,
    "disk_usage_gb": "<string>",
    "network_in_bytes": 0,
    "network_out_bytes": 0,
    "sync_source": "<string>"
  },
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "hostname": "<string>",
  "tags": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Instance.

​
organization_id
string
required

Unique identifier of the organization that owns the resource.

​
project_id
string
required

Unique identifier of the project containing the resource.

Body

application/json
​
name
string

Instance name

Maximum string length: 255
​
hostname
string

Instance hostname

Maximum string length: 255
​
size_id
string<uuid>
write-only
​
location_id
string<uuid>
write-only
​
vpc_id
string<uuid> | null
write-only
​
image_id
string<uuid>
write-only
​
os_name
string

Operating system name

Maximum string length: 100
​
billing_cycle
enum<string>
  • free - Free
  • one_time - One Time
  • hourly - Hourly
  • monthly - Monthly
  • quarterly - Quarterly
  • semi_annually - Semi-Annually
  • annually - Annually
  • biennially - Biennially
  • triennially - Triennially
Available options:
free,
one_time,
hourly,
monthly,
quarterly,
semi_annually,
annually,
biennially,
triennially
​
tags
any

Custom tags

Response

Instance updated successfully

​
id
string<uuid>
required
read-only
​
legacy_id
integer
required
read-only
​
organization_id
string<uuid>
required
read-only
​
project_id
string<uuid>
required
read-only
​
name
string
required

Instance name

Maximum string length: 255
​
status
enum<string>
required
read-only

Billing status

  • pending - Pending
  • provisioning - Provisioning
  • active - Active
  • suspended - Suspended
  • terminated - Terminated
  • cancelled - Cancelled
Available options:
pending,
provisioning,
active,
suspended,
terminated,
cancelled
​
size
object
required
​
location
object
required
​
vpc
object
required
​
image
object
required
​
os_name
string
required

Operating system name

Maximum string length: 100
​
primary_ipv4
string<uuid> | null
required
read-only

Primary IPv4 address

​
primary_ipv6
string<uuid> | null
required
read-only

Primary IPv6 address

​
ip_addresses
object[]
required
read-only
​
volumes
object[]
required
read-only
​
billing_start_date
string<date-time>
required
read-only
​
billing_end_date
string<date-time> | null
required
read-only

For prepaid only

​
next_billing_date
string<date-time> | null
required
read-only
​
cancellation_requested_at
string<date-time> | null
required
read-only

When cancellation was requested, effective at billing_end_date

​
cancellation_reason
string
required
read-only

Reason provided for cancellation request

​
bandwidth_used_gb
string
required
read-only
Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
​
is_active
boolean
required
read-only
​
is_installed
boolean
required
read-only

Whether the instance OS/service has been installed

​
state_sync
object
required
​
created
string<date-time>
required
read-only
​
modified
string<date-time>
required
read-only
​
hostname
string

Instance hostname

Maximum string length: 255
​
billing_cycle
enum<string>
  • free - Free
  • one_time - One Time
  • hourly - Hourly
  • monthly - Monthly
  • quarterly - Quarterly
  • semi_annually - Semi-Annually
  • annually - Annually
  • biennially - Biennially
  • triennially - Triennially
Available options:
free,
one_time,
hourly,
monthly,
quarterly,
semi_annually,
annually,
biennially,
triennially
​
tags
any

Custom tags